口座振替サービス

口座振替ペーパー申込 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

BankAccountPaperEntry 口座登録依頼書データ登録

口座登録依頼書のデータ登録を行います。

リクエスト
SiteID siteID 必須 半角英数13桁
サイトID

SitePass sitePass 必須 半角英数64桁
サイトパスワード

ShopID shopID 必須 半角英数13桁
ショップID

MemberID memberID 必須 半角英数60桁
会員ID

MemberName memberName 全半角255バイト
会員名

指定した「会員ID」が新規の場合に必須です。

FinancialInstituteType financialInstituteType 必須 半角数字1桁
金融機関区分

金融機関の区分を設定します。

0：ゆうちょ銀行以外
1：ゆうちょ銀行

BankCode bankCode 半角数字4桁
金融機関コード

金融機関区分が「0：ゆうちょ銀行以外」 の場合に必須です。「1：ゆうちょ銀行」の場合に入力するとエラーを返却します。

BranchCode branchCode 半角数字3桁
支店コード

金融機関区分が「0：ゆうちょ銀行以外」 の場合に必須です。「1：ゆうちょ銀行」の場合に入力するとエラーを返却します。

AccountType accountType 半角数字1桁 固定
預金種別

金融機関区分が「0：ゆうちょ銀行以外」 の場合に必須です。「1：ゆうちょ銀行」の場合に入力するとエラーを返却します。
預金口座の種別を設定します。

1：普通
2：当座

AccountNumber accountNumber 半角数字7桁
口座番号

金融機関区分が「0：ゆうちょ銀行以外」 の場合に必須です。「1：ゆうちょ銀行」の場合に入力するとエラーを返却します。

PostalAccountNumber1 postalAccountNumber1 半角数字5桁
ゆうちょ口座 - 記号

金融機関区分が「1：ゆうちょ銀行」 の場合に必須です。「0：ゆうちょ銀行以外」の場合は入力するとエラーを返却します。

PostalAccountNumber2 postalAccountNumber2 半角数字8桁
ゆうちょ口座 - 番号

金融機関区分が「1：ゆうちょ銀行」 の場合に必須です。「0：ゆうちょ銀行以外」の場合は入力するとエラーを返却します。

AccountOwnerType accountOwnerType 必須 半角数字1桁 固定
口座名義区分

口座名義の区分を設定します。

0：個人
1：法人

AccountNameSei accountNameSei 全角15桁
口座名義（姓）

口座所有者タイプが「0：個人」の場合に必須です。「1：法人」の場合は入力するとエラーを返却します。

AccountNameMei accountNameMei 全角15桁
口座名義（名）

口座所有者タイプが「0：個人」の場合に必須です。「1：法人」の場合は入力するとエラーを返却します。

AccountNameSeiKana accountNameSeiKana 半角英数カナ記号29桁
口座名義（姓）カナ

口座所有者タイプが「0：個人」の場合に必須です。「1：法人」の場合は入力するとエラーを返却します。
口座名義カナを半角で設定します。
姓、名を合計し、29桁まで設定可能です。
※全角で設定した場合、半角に変換します。

AccountNameMeiKana accountNameMeiKana 半角英数カナ記号29桁
口座名義（名）カナ

口座所有者タイプが「0：個人」の場合に必須です。「1：法人」の場合は入力するとエラーを返却します。
口座名義カナを半角で設定します。
姓、名を合計し、29桁まで設定可能です。
※全角で設定した場合、半角に変換します。

AccountNameBisiness accountNameBisiness 全角30桁
口座名義（法人）

口座所有者タイプが「1：法人」の場合に必須です。
「0：個人」の場合は入力するとエラーを返却します。

AccountNameBisinessKana accountNameBisinessKana 半角英数カナ記号30桁
口座名義（法人）カナ

口座所有者タイプが「1：法人」の場合に必須です。
「0：個人」の場合は入力するとエラーを返却します。
口座名義（法人）を半角で設定します。
※全角で設定した場合、半角に変換します。

OperationType operationType 必須 半角英字6桁
操作種別

REGIST： 保存
　口座登録情報を保存します。
　確定は管理画面から実施してください。
　※確定実行用のAPIは現在未提供です。
　COMMIT：保存＋確定
　口座登録情報を保存し、確定します。
　管理画面から確定する必要はありません。

URL
/payment/BankAccountPaperEntry.json
リクエストパラメータ
{
  "siteID": "tsite99887902",
  "sitePass": "pass",
  "shopID": "tshop11223344",
  "memberID": "member01",
  "memberName": "会員名  ",
  "financialInstituteType": "0",
  "bankCode": "0005",
  "branchCode": "001",
  "accountType": "1",
  "accountNumber": "1234567",
  "postalAccountNumber1": "",
  "postalAccountNumber2": "",
  "accountOwnerType": "0",
  "accountNameSei": "口座",
  "accountNameMei": "名義",
  "accountNameSeiKana": "コウザ",
  "accountNameMeiKana": "メイギ",
  "accountNameBisiness": "",
  "accountNameBisinessKana": "",
  "operationType": "COMMIT"
}
URL
/payment/BankAccountPaperEntry.idPass
リクエストパラメータ
SiteID=tsite99887902&SitePass=pass&ShopID=tshop11223344&MemberID=member01&MemberName=会員名  &FinancialInstituteType=0&BankCode=0005&BranchCode=001&AccountType=1&AccountNumber=1234567&PostalAccountNumber1=&PostalAccountNumber2=&AccountOwnerType=0&AccountNameSei=口
座&AccountNameMei=名義&AccountNameSeiKana=コウザ&AccountNameMeiKana=メイギ&AccountNameBisiness=&AccountNameBisinessKana=&OperationType=COMMIT
レスポンス
正常
TranID tranID 半角英数40桁 固定
申込ID

口座登録依頼の申込みIDです。

SiteID siteID 半角英数13桁
サイトID

操作種別に「COMMIT」を設定した場合のみ出力します。

MemberID memberID 半角英数記号60桁
会員ID

操作種別に「COMMIT」を設定した場合のみ出力します。

AccountSeq accountSeq 半角数字4桁
登録連番

会員IDに紐付く口座情報の登録連番です。操作種別に「COMMIT」を設定した場合のみ出力します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "tranID": "abcde01234abcde01234abcde01234abcde01234",
  "siteID": "tsite99887902",
  "memberID": "member01",
  "accountSeq": "0"
}
レスポンスパラメータ：正常系
TranID=abcde01234abcde01234abcde01234abcde01234&SiteID=tsite99887902&MemberID=member01&AccountSeq=0
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchBankAccountPaperEntry 口座登録依頼書データ照会

登録した口座登録依頼書データを取得します。 口座登録依頼書データ登録API以外に管理画面から登録したデータも照会可能です。

リクエスト
TranID tranID 必須 半角英数40桁 固定
申込ID

口座登録依頼書データ登録時に返却された値を設定します。

SiteID siteID 必須 半角英数13桁
サイトID

SitePass sitePass 必須 半角英数64桁
サイトパスワード

URL
/payment/SearchBankAccountPaperEntry.json
リクエストパラメータ
{
  "tranID": "abcde01234abcde01234abcde01234abcde01234",
  "siteID": "tsite99887902",
  "sitePass": "pass"
}
URL
/payment/SearchBankAccountPaperEntry.idPass
リクエストパラメータ
TranID=abcde01234abcde01234abcde01234abcde01234&SiteID=tsite99887902&SitePass=pass
レスポンス
正常
TranID tranID 半角英数40桁 固定
申込ID

口座登録依頼の申込みIDです。

Status status 半角英字8桁
ステータス

口座登録依頼書データの登録状況です。

REGISTER：登録
CONFIRM：確定
OK：振替実績あり
NG：不備

SiteID siteID 半角英数13桁
サイトID

MemberID memberID 半角英数60桁
会員ID

RegistDate registDate 半角数字14桁 固定
登録日時

yyyyMMddHHmmss形式

RegistUser registUser 半角英数13桁
登録者

口座登録依頼書データ登録時のユーザーIDです。

ConfirmDate confirmDate 半角数字14桁 固定
確定日時

口座登録依頼書データ確定時の日時です。
yyyyMMddHHmmss形式

ConfirmUser confirmUser 半角英数13桁
確定者

口座登録依頼書データ確定時のユーザーIDです。

NgDate ngDate 半角数字14桁 固定
不備登録日時

口座登録依頼の不備を登録した日時です。
yyyyMMddHHmmss形式

NgReason ngReason 半角英数1桁
不備理由コード

口座登録依頼が不備となった理由コードです。

1：預金なし
2：記載事項相違
3：印鑑相違
4：その他
5：印鑑不鮮明
6：記載事項記入漏れ
7：設定手続き未完了
8：委託者都合
9：初回振替NG
a：記載事項相違(名義字体)
b：記入事項相違(肩書き・代表者名)
c：該当口座なし
d：預金者承認なし
A：加盟店操作による停止

NgNote ngNote 全半角244バイト
不備理由備考

口座登録依頼の不備に関する備考です。

FinancialInstituteType financialInstituteType 半角数字1桁
金融機関区分

BankCode bankCode 半角数字4桁
金融機関コード

BankName bankName 全角30桁
金融機関名

金融機関コードに紐付く金融機関名です。

BranchCode branchCode 半角数字3桁
支店コード

BranchName branchName 全角30桁
支店名

支点コードに紐付く支店名です。

AccountType accountType 半角数字1桁
預金種別

AccountOwnerType accountOwnerType 半角数字1桁
口座名義区分

AccountNameSei accountNameSei 全角30桁
口座名義（姓）

AccountNameMei accountNameMei 全角30桁
口座名義（名）

AccountNameSeiKana accountNameSeiKana 半角英数カナ記号60桁
口座名義（姓）カナ

AccountNameMeiKana accountNameMeiKana 半角英数カナ記号60桁
口座名義（名）カナ

AccountNameBisiness accountNameBisiness 全角60桁
口座名義（法人）

AccountNameBisinessKana accountNameBisinessKana 半角英数カナ記号60桁
口座名義（法人）カナ

AccountNumber accountNumber 半角数字7桁
口座番号

PostalAccountNumber1 postalAccountNumber1 半角数字5桁
ゆうちょ口座 - 記号

PostalAccountNumber2 postalAccountNumber2 半角数字8桁
ゆうちょ口座 - 番号

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "tranID": "abcde01234abcde01234abcde01234abcde01234",
  "status": "CONFIRM",
  "siteID": "tsite99887902",
  "memberID": "member01",
  "registDate": "20220701102712",
  "registUser": "ONLINE PROCESS",
  "confirmDate": "20220701102712",
  "confirmUser": "ONLINE PROCESS",
  "ngDate": "20220701102712",
  "ngReason": "1",
  "ngNote": "0",
  "financialInstituteType": "",
  "bankCode": "",
  "bankName": "",
  "branchCode": "",
  "branchName": "",
  "accountType": "",
  "accountOwnerType": "",
  "accountNameSei": "会員姓",
  "accountNameMei": "会員名",
  "accountNameSeiKana": "ｶｲｲﾝｾｲ",
  "accountNameMeiKana": "ｶｲｲﾝﾒｲ",
  "accountNameBisiness": "",
  "accountNameBisinessKana": "",
  "accountNumber": "",
  "postalAccountNumber1": "12345",
  "postalAccountNumber2": "12345678"
}
レスポンスパラメータ：正常系
TranID=abcde01234abcde01234abcde01234abcde01234&Status=CONFIRM&SiteID=tsite99887902&MemberID=member01&RegistDate=20221211133248&RegistUser=samplesan&ConfirmDate=20221211133248&ConfirmUser=samplesan&NgDate=&NgReason=&NgNote=&FinancialInstituteType=0&BankCode=0005&BankName=三菱ＵＦＪ銀行&BranchCode=002&BranchName=丸の内支店&AccountType=1&AccountOwnerType=0&AccountNameSei=口座&AccountNameMei=名義&AccountNameSeiKana=ｺｳｻﾞ&AccountNameMeiKana=ﾒｲｷﾞ&AccountNameBisiness=&AccountNameBisinessKana=&AccountNumber=1234567&PostalAccountNumber1=&PostalAccountNumber2=
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001